driver: implement tkv driver for tarantool support #10

bigbes · 2025-10-16T11:31:48Z

New Tarantool Config Storage (TCS) driver package (driver/tcs).
Integration testing for TCS
Updated .golangci.yml to fix needed packages and modify default testing rules.
Modified core driver interfaces to be compatible with tcs.
Update go module dependencies.

Closes #TNTP-4188

Copilot

Pull Request Overview

Introduce a new Tarantool TKV driver and align core interfaces and models to support it

Add TKV driver with transactional execution and key watch support
Adjust driver interfaces (Watch signature) and data models (KeyValue, RequestResponse) for compatibility
Add integration tests against a Tarantool instance and update dependencies and lint configuration

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
driver/tkv/tkv.go	Implements TKV driver Execute and Watch, wiring to Tarantool watcher API.
driver/tkv/txn.go	Defines request/response encoding/decoding and maps Tarantool responses to tx.Response.
driver/tkv/operations.go	Encodes operations (get/put/delete) for TKV.
driver/tkv/predicate.go	Encodes predicates and maps ops/targets to TKV equivalents.
driver/tkv/integration_test.go	Integration tests validating put/get/delete, predicates, multi-op, and watch behavior.
driver/driver.go	Changes Watch API to return a channel, a stop function, and an error.
driver/etcd/etcd.go	Updates Watch signature to match the new Driver interface.
watch/event.go	Simplifies Event to contain only Prefix.
tx/requestresponse.go	Refactors RequestResponse to hold a slice of KeyValue values.
kv/kv.go	Removes CreateRevision and Version fields; keeps ModRevision.
internal/mocks/driver_mock.go	Updates mocks to match the new Watch signature.
go.mod	Adds msgpack/v5 as a direct dependency.
.golangci.yml	Allows msgpack imports and tarantool packages in tests.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

driver/tkv/operations.go

driver/tkv/tkv.go

tx/requestresponse.go

driver/driver.go

watch/event.go

coveralls · 2025-10-16T12:50:00Z

Pull Request Test Coverage Report for Build 18777587711

Details

182 of 966 (18.84%) changed or added relevant lines in 14 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-0.8%) to 21.09%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
driver/etcd/etcd.go	0	1	0.0%
driver/tcs/txn.go	31	35	88.57%
internal/mocks/driver_mock.go	0	8	0.0%
driver/tcs/predicate.go	34	44	77.27%
internal/testing/t.go	0	14	0.0%
driver/tcs/operations.go	31	47	65.96%
internal/testing/request.go	0	24	0.0%
internal/testing/response.go	0	40	0.0%
internal/testing/doerwithwatcher.go	0	44	0.0%
internal/testing/doer.go	0	47	0.0%

Totals
Change from base Build 18098700518:	-0.8%
Covered Lines:	360
Relevant Lines:	1707

💛 - Coveralls

Copilot

Pull Request Overview

Copilot reviewed 14 out of 14 changed files in this pull request and generated 6 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

watch/event.go

driver/tcs/tcs.go

Copilot · 2025-10-16T12:53:03Z

driver/tcs/tcs.go

+	return rvChan, func() { close(isStopped) }, nil
+}


The returned stop function will panic if called more than once due to closing the same channel twice. Make it idempotent, e.g., by wrapping the close with a sync.Once or an atomic guard.

driver/tcs/tcs.go

tx/requestresponse.go

kv/kv.go

oleg-jukovec

Please, rename TKV -> TcS or TCS everywhere.

oleg-jukovec

Please, update the CI impl commit title & message.

oleg-jukovec

It is a nice idea to start the CHANGELOG.md here. Or you could it fill on the first release. Up to you.

oleg-jukovec · 2025-10-20T14:39:48Z

.github/actions/prepare-ee-test-env/action.yml

+
+env:
+  # Note: Use exactly match version of tool, to avoid unexpected issues with test on CI.
+  GO_VERSION: '1.23.8'


But the library requires 1.24 in the go.mod.

oleg-jukovec · 2025-10-20T14:40:23Z

.github/actions/prepare-ee-test-env/action.yml

+    - name: Setup python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '${{ env.PYTHON_VERSION }}'
+
+    - name: Setup Mage
+      run: |
+        git clone https://github.com/magefile/mage
+        cd mage
+        go run bootstrap.go
+      shell: bash
+
+    - name: Install build requirements
+      run: |
+        sudo apt -y update
+        sudo apt -y install git gcc make cmake unzip zip fish zsh
+      shell: bash


We don't need the stuff here.

oleg-jukovec · 2025-10-20T14:40:34Z

.github/actions/prepare-ee-test-env/action.yml

+        tar -xzf ${ARCHIVE_NAME}
+        rm -f ${ARCHIVE_NAME}
+        source tarantool-enterprise/env.sh
+      shell: bash


Please, add a newline.

oleg-jukovec · 2025-10-20T14:40:53Z

.github/actions/prepare-ee-test-env/action.yml

+    - name: Setup Go
+      uses: actions/setup-go@v4
+      with:
+        go-version: '${{ env.GO_VERSION }}'


Probably we don't need the Go here. It is better to install the Go in a job pipeline directly.

oleg-jukovec · 2025-10-20T14:41:19Z

.github/actions/setup-etcd/action.yml

+        ${INSTALL_PREFIX}/etcd --version
+        ${INSTALL_PREFIX}/etcdctl version 2>/dev/null || ${INSTALL_PREFIX}/etcdctl --version
+        echo "ETCD_PATH=$(echo $INSTALL_PREFIX)" >> "$GITHUB_ENV"
+        echo "${INSTALL_PREFIX}" >> "$GITHUB_PATH"


Please, add a newline.

oleg-jukovec · 2025-10-20T14:54:32Z

driver/tkv/predicate.go

+// FailedToEncodeTkvPredicateError is returned when we failed to encode tkvPredicate.
+type FailedToEncodeTkvPredicateError struct {


The same about the too long naming.

oleg-jukovec · 2025-10-20T14:56:07Z

driver/tcs/integration_test.go

+// skipIfNoTarantool skips the test if no Tarantool instance is available.
+func skipIfNoTarantool(t *testing.T) {


We need skip tests with TCS in case of Tarantool CE.

oleg-jukovec · 2025-10-20T15:02:00Z

driver/driver.go

-	Watch(ctx context.Context, key []byte, opts ...watch.Option) <-chan watch.Event
+	// The returned cleanup function should be called to stop the watch and release resources.
+	// An error is returned if the watch could not be established.
+	Watch(ctx context.Context, key []byte, opts ...watch.Option) (<-chan watch.Event, func(), error)


We need a tests that the TCS driver implements the Driver interface.

This is used, instead:

go-storage/driver/tcs/tcs.go

Line 33 in 5285223

_ driver.Driver = &Driver{} //nolint:exhaustruct

oleg-jukovec · 2025-10-20T15:03:51Z

driver/tkv/integration_test.go

@@ -0,0 +1,771 @@
+package tkv_test


There are a lack of negative tests. At least without a successful connect.

Too complex nagative scenarios should be tested with unit-tests.

added test for unsuccesfull connect (== no rw instance in pool

👍

oleg-jukovec · 2025-10-20T15:05:37Z

driver/tcs/tcs.go

+// New creates a new Tarantool driver instance.
+// It establishes connections to Tarantool instances using the provided addresses.
+func New(doer DoerWatcher) *Driver {


Please, add two examples of usage the driver: Execute & Watcher.

The examples could be added into a root directory of the project to example_test.go (I prefer the way).
Or in the package.

Up to you.

Copilot

Pull Request Overview

Copilot reviewed 32 out of 32 changed files in this pull request and generated 1 comment.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

driver/tcs/operations.go

Copilot

Pull Request Overview

Copilot reviewed 32 out of 32 changed files in this pull request and generated 2 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

driver/tcs/integration_test.go

driver/tcs/tcs.go

Copilot

Pull Request Overview

Copilot reviewed 32 out of 32 changed files in this pull request and generated 1 comment.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Makefile

- New Tarantool Config Storage (TCS) driver package (driver/tcs). - Integration testing for TCS. - Updated .golangci.yml. - Modified core driver interfaces to be compatible with tcs. - Update go module dependencies. Closes #TNTP-4188

bigbes requested review from Copilot, elhimov and oleg-jukovec October 16, 2025 11:31

Copilot AI reviewed Oct 16, 2025

View reviewed changes

driver/tkv/operations.go Outdated Show resolved Hide resolved

driver/tkv/tkv.go Show resolved Hide resolved

tx/requestresponse.go Outdated Show resolved Hide resolved

driver/driver.go Show resolved Hide resolved

watch/event.go Outdated Show resolved Hide resolved

bigbes force-pushed the elhimov/tntp-4188-implement-tkv-driver branch from 7531a92 to c5c3cb7 Compare October 16, 2025 12:48

bigbes requested a review from Copilot October 16, 2025 12:48

Copilot AI reviewed Oct 16, 2025

View reviewed changes

bigbes added the full-ci label Oct 16, 2025

bigbes force-pushed the elhimov/tntp-4188-implement-tkv-driver branch 2 times, most recently from 870c579 to 2df1217 Compare October 16, 2025 15:43

oleg-jukovec added full-ci and removed full-ci labels Oct 16, 2025

bigbes force-pushed the elhimov/tntp-4188-implement-tkv-driver branch from 2df1217 to 2c88b0b Compare October 16, 2025 15:51

bigbes added full-ci and removed full-ci labels Oct 16, 2025

bigbes force-pushed the elhimov/tntp-4188-implement-tkv-driver branch from 2c88b0b to 1d5d4ed Compare October 16, 2025 16:15

oleg-jukovec requested changes Oct 20, 2025

View reviewed changes

oleg-jukovec reviewed Oct 20, 2025

View reviewed changes

oleg-jukovec requested changes Oct 20, 2025

View reviewed changes

bigbes force-pushed the elhimov/tntp-4188-implement-tkv-driver branch 8 times, most recently from 5414399 to bdd88e7 Compare October 24, 2025 10:35

bigbes requested a review from oleg-jukovec October 24, 2025 10:36

bigbes requested a review from Copilot October 24, 2025 10:37

Copilot AI reviewed Oct 24, 2025

View reviewed changes

driver/tcs/operations.go Outdated Show resolved Hide resolved

bigbes force-pushed the elhimov/tntp-4188-implement-tkv-driver branch from bdd88e7 to 3d42b92 Compare October 24, 2025 10:38

bigbes requested a review from Copilot October 24, 2025 10:39

Copilot AI reviewed Oct 24, 2025

View reviewed changes

driver/tcs/integration_test.go Outdated Show resolved Hide resolved

driver/tcs/tcs.go Show resolved Hide resolved

bigbes force-pushed the elhimov/tntp-4188-implement-tkv-driver branch 2 times, most recently from 16fb273 to 1b7f28b Compare October 24, 2025 10:49

bigbes requested a review from Copilot October 24, 2025 10:50

Copilot AI reviewed Oct 24, 2025

View reviewed changes

Makefile Show resolved Hide resolved

driver: implement tcs driver for tarantool support

e2cc7fa

- New Tarantool Config Storage (TCS) driver package (driver/tcs). - Integration testing for TCS. - Updated .golangci.yml. - Modified core driver interfaces to be compatible with tcs. - Update go module dependencies. Closes #TNTP-4188

bigbes force-pushed the elhimov/tntp-4188-implement-tkv-driver branch from 1b7f28b to e2cc7fa Compare October 24, 2025 10:52

		// FailedToEncodeTkvPredicateError is returned when we failed to encode tkvPredicate.
		type FailedToEncodeTkvPredicateError struct {

		// skipIfNoTarantool skips the test if no Tarantool instance is available.
		func skipIfNoTarantool(t *testing.T) {

driver: implement tkv driver for tarantool support #10

Are you sure you want to change the base?

driver: implement tkv driver for tarantool support #10

Uh oh!

Conversation

bigbes commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coveralls commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 18777587711

Details

💛 - Coveralls

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

oleg-jukovec left a comment

Choose a reason for hiding this comment

Uh oh!

oleg-jukovec left a comment

Choose a reason for hiding this comment

Uh oh!

oleg-jukovec left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

bigbes commented Oct 16, 2025 •

edited

Loading

coveralls commented Oct 16, 2025 •

edited

Loading